home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / PInterfaces / Aliases.p < prev    next >
Text File  |  1996-05-01  |  6KB  |  162 lines
  1. {
  2.      File:        Aliases.p
  3.  
  4.      Contains:    Alias Manager Interfaces.
  5.  
  6.      Version:    Technology:    System 7.5
  7.                  Release:    Universal Interfaces 3.0d3 on Copland DR1
  8.  
  9.      Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10.  
  11.      Bugs?:        If you find a problem with this file, send the file and version
  12.                  information (from above) and the problem description to:
  13.  
  14.                      Internet:    apple.bugs@applelink.apple.com
  15.                      AppleLink:    APPLE.BUGS
  16.  
  17. }
  18. {$IFC UNDEFINED UsingIncludes}
  19. {$SETC UsingIncludes := 0}
  20. {$ENDC}
  21.  
  22. {$IFC NOT UsingIncludes}
  23.  UNIT Aliases;
  24.  INTERFACE
  25. {$ENDC}
  26.  
  27. {$IFC UNDEFINED __ALIASES__}
  28. {$SETC __ALIASES__ := 1}
  29.  
  30. {$I+}
  31. {$SETC AliasesIncludes := UsingIncludes}
  32. {$SETC UsingIncludes := 1}
  33.  
  34. {$IFC UNDEFINED __TYPES__}
  35. {$I Types.p}
  36. {$ENDC}
  37. {$IFC UNDEFINED __APPLETALK__}
  38. {$I AppleTalk.p}
  39. {$ENDC}
  40. {$IFC UNDEFINED __FILES__}
  41. {$I Files.p}
  42. {$ENDC}
  43.  
  44. {$PUSH}
  45. {$ALIGN MAC68K}
  46. {$LibExport+}
  47.  
  48. {$IFC FOR_SYSTEM7_AND_SYSTEM8_COOPERATIVE }
  49.  
  50. CONST
  51.     rAliasType                    = 'alis';                        {  Aliases are stored as resources of this type  }
  52.                                                                 {  define alias resolution action rules mask  }
  53.     kARMMountVol                = $00000001;                    {  mount the volume automatically  }
  54.     kARMNoUI                    = $00000002;                    {  no user interface allowed during resolution  }
  55.     kARMMultVols                = $00000008;                    {  search on multiple volumes  }
  56.     kARMSearch                    = $00000100;                    {  search quickly  }
  57.     kARMSearchMore                = $00000200;                    {  search further  }
  58.     kARMSearchRelFirst            = $00000400;                    {  search target on a relative path first  }
  59.                                                                 {  define alias record information types  }
  60.     asiZoneName                    = -3;                            {  get zone name  }
  61.     asiServerName                = -2;                            {  get server name  }
  62.     asiVolumeName                = -1;                            {  get volume name  }
  63.     asiAliasName                = 0;                            {  get aliased file/folder/volume name  }
  64.     asiParentName                = 1;                            {  get parent folder name  }
  65.  
  66. {  define the alias record that will be the blackbox for the caller  }
  67.  
  68. TYPE
  69.     AliasRecordPtr = ^AliasRecord;
  70.     AliasRecord = RECORD
  71.         userType:                OSType;                                    {  appl stored type like creator type  }
  72.         aliasSize:                INTEGER;                                {  alias record size in bytes, for appl usage  }
  73.     END;
  74.  
  75.     AliasPtr                            = ^AliasRecord;
  76.     AliasHandle                            = ^AliasPtr;
  77. {  alias record information type  }
  78.     AliasInfoType                        = INTEGER;
  79. {   create a new alias between fromFile-target and return alias record handle   }
  80. FUNCTION NewAlias(fromFile: ConstFSSpecPtr; {CONST}VAR target: FSSpec; VAR alias: AliasHandle): OSErr;
  81.     {$IFC NOT GENERATINGCFM}
  82.     INLINE $7002, $A823;
  83.     {$ENDC}
  84. {  create a minimal new alias for a target and return alias record handle  }
  85. FUNCTION NewAliasMinimal({CONST}VAR target: FSSpec; VAR alias: AliasHandle): OSErr;
  86.     {$IFC NOT GENERATINGCFM}
  87.     INLINE $7008, $A823;
  88.     {$ENDC}
  89. {  create a minimal new alias from a target fullpath (optional zone and server name) and return alias record handle   }
  90. FUNCTION NewAliasMinimalFromFullPath(fullPathLength: INTEGER; fullPath: UNIV Ptr; zoneName: Str32; serverName: Str31; VAR alias: AliasHandle): OSErr;
  91.     {$IFC NOT GENERATINGCFM}
  92.     INLINE $7009, $A823;
  93.     {$ENDC}
  94. {  given an alias handle and fromFile, resolve the alias, update the alias record and return aliased filename and wasChanged flag.  }
  95. FUNCTION ResolveAlias(fromFile: ConstFSSpecPtr; alias: AliasHandle; VAR target: FSSpec; VAR wasChanged: BOOLEAN): OSErr;
  96.     {$IFC NOT GENERATINGCFM}
  97.     INLINE $7003, $A823;
  98.     {$ENDC}
  99. {  given an alias handle and an index specifying requested alias information type, return the information from alias record as a string.  }
  100. FUNCTION GetAliasInfo(alias: AliasHandle; index: AliasInfoType; VAR theString: Str63): OSErr;
  101.     {$IFC NOT GENERATINGCFM}
  102.     INLINE $7007, $A823;
  103.     {$ENDC}
  104. {
  105.   Given a file spec, return target file spec if input file spec is an alias.
  106.   It resolves the entire alias chain or one step of the chain.  It returns
  107.   info about whether the target is a folder or file; and whether the input
  108.   file spec was an alias or not. 
  109. }
  110. FUNCTION ResolveAliasFile(VAR theSpec: FSSpec; resolveAliasChains: BOOLEAN; VAR targetIsFolder: BOOLEAN; VAR wasAliased: BOOLEAN): OSErr;
  111.     {$IFC NOT GENERATINGCFM}
  112.     INLINE $700C, $A823;
  113.     {$ENDC}
  114. FUNCTION FollowFinderAlias(fromFile: ConstFSSpecPtr; alias: AliasHandle; logon: BOOLEAN; VAR target: FSSpec; VAR wasChanged: BOOLEAN): OSErr;
  115.     {$IFC NOT GENERATINGCFM}
  116.     INLINE $700F, $A823;
  117.     {$ENDC}
  118. {
  119.    Low Level Routines 
  120. }
  121. {  given a fromFile-target pair and an alias handle, update the lias record pointed to by alias handle to represent target as the new alias.  }
  122. FUNCTION UpdateAlias(fromFile: ConstFSSpecPtr; {CONST}VAR target: FSSpec; alias: AliasHandle; VAR wasChanged: BOOLEAN): OSErr;
  123.     {$IFC NOT GENERATINGCFM}
  124.     INLINE $7006, $A823;
  125.     {$ENDC}
  126. {$ENDC}
  127. {$IFC FOR_SYSTEM7_AND_SYSTEM8_DEPRECATED }
  128.  
  129. TYPE
  130.     AliasFilterProcPtr = ProcPtr;  { FUNCTION AliasFilter(cpbPtr: CInfoPBPtr; VAR quitFlag: BOOLEAN; myDataPtr: Ptr): BOOLEAN; }
  131.  
  132.     AliasFilterUPP = UniversalProcPtr;
  133.  
  134. CONST
  135.     uppAliasFilterProcInfo = $00000FD0;
  136.  
  137. FUNCTION NewAliasFilterProc(userRoutine: AliasFilterProcPtr): AliasFilterUPP;
  138.     {$IFC NOT GENERATINGCFM }
  139.     INLINE $2E9F;
  140.     {$ENDC}
  141.  
  142. FUNCTION CallAliasFilterProc(cpbPtr: CInfoPBPtr; VAR quitFlag: BOOLEAN; myDataPtr: Ptr; userRoutine: AliasFilterUPP): BOOLEAN;
  143.     {$IFC NOT GENERATINGCFM}
  144.     INLINE $205F, $4E90;
  145.     {$ENDC}
  146. {   Given an alias handle and fromFile, match the alias and return aliased filename(s) and needsUpdate flag  }
  147. FUNCTION MatchAlias(fromFile: ConstFSSpecPtr; rulesMask: LONGINT; alias: AliasHandle; VAR aliasCount: INTEGER; aliasList: FSSpecArrayPtr; VAR needsUpdate: BOOLEAN; aliasFilter: AliasFilterUPP; yourDataPtr: UNIV Ptr): OSErr;
  148.     {$IFC NOT GENERATINGCFM}
  149.     INLINE $7005, $A823;
  150.     {$ENDC}
  151. {$ENDC}
  152. {$ALIGN RESET}
  153. {$POP}
  154.  
  155. {$SETC UsingIncludes := AliasesIncludes}
  156.  
  157. {$ENDC} {__ALIASES__}
  158.  
  159. {$IFC NOT UsingIncludes}
  160.  END.
  161. {$ENDC}
  162.